In this document, additional tools for use with the new SAPE-enviroment
are described.


mkdoc
=====

This is a tool for automated creation of documentation in PDF and HTML format
and for creation of Word DOC format files for reviewing purposes from SAP/AIM
definition files available in XML-format. 

MkDoc    : Create SAP and AIM documentation
Usage    : MkDoc [-sr <sapRootDir>] [-ar <aimRootDir>] [-d <destDir>]
                 [-help | ((-pdf | -pdf1 | -reviewdoc) <docName> (sap|aim)) | -html]
Example  : MkDoc -sr .\SAP -ar .\AIM -pdf DTI2 sap
             ;creates pdf documentation for DTI2 in sapepdf directory
    -sr  : set <sapRootDir> as directory for the SAP documents (*.sap)
    -ar  : set <aimRootDir> as directory for the AIM documents (*.aim)
    -d   : set <destDir> as root directory for the documentation
    -pdf : generate pdf format documentation.
    -pdf1: generate legacy version of ps/pdf format documentation.
    -reviewdoc:
           generate Word document format version of documentation
           for review purposes.
    <docName>
           Name of the document for which documentation is to be generated,
           without suffix.
    -html: generate HTML version of documentation for all SAP/AIM documents.
    -help: display this message
    
To view the generated HTML documentation, go into the doc directory and open
"index.html".


makcdg
======

This one does what it used to do. Except that the version adapted for sape
looks for files with the endings ".sap" and ".aim" in the respective doc-
directories and creates pdf/mdf files from those instead of from the ".doc"-
files if it finds them. With this mechanism, it is possible to either just
have some documents in xml format or to use only documents in xml-format.

NOTE: to make makcdg recompute pdf/mdf-files, they must be older than the
sap/aim-files, no matter which format you use. If you want to be sure that
all new sap/aim files are really processed, just delete the contents of the
"dfile"-folder in the g23m\condat\ms directory.


doc2xml
=======

This tool is used for automated conversion of SAP/AIM-documents from the
".doc"-format into xml. Since it does not work entirely without manual
support, its handling by now is not within the scope of the SAPE-user
environment.

If you have to use it anyway, you will first have to install the ruby
interpreter environment in the version Ruby 1.7.3-8 from 
http://sourceforge.net/project/showfiles.php?group_id=67007
and make sure that the ruby/bin directory is accessible somewhere in the
path. Then call doc2xml from \gpf\util\sape\bin\ with the parameter "g23"
or "umts", depending on which doc files you want to translate.
Alternatively, you may provide a "." as the first parameter, indicating
that the files in the present working directory should be taken.
To just translate one single file, provide its name (without suffix) and,
as a second parameter the flag "sap" or "aim" to tell the tool which kind
of translation to try.

Be prepared for some nasty problems and not overly helpful error messages
when translating big files and those which have a long history since there
very likely will be some things the parser finds impossible to understand.
The most likely candidates for this are date formats (and other
inconsistencies in the history/document history) and invisible characters
and formatting options in the word document.


Good luck :-)

04-07-16
tvo
